Management API

Base Resource URL:

     https://portaldev.eonpayments.com/api/v01/customers/[customer-id]/subscriptions

Description:

Allows to manage the subscriptions associated with the specified customer.

Available sub-resources:

Resource URL Description
https://portaldev.eonpayments.com/api/v01/customers/[customer-id]/subscriptions/[subscription-id]    Allows to manage the specified subscription.

Supported Actions:

create  
Method:  PUT       Implicit:  Yes       Returns:  Subscription *      
Consumes:  json, xml  Produces:  json, xml 
 
Create subscription by linking customer to payment plan for automated recurring charges.
- Requires existing customer, payment plan, and payment method (card or bank account).
- Payment schedule follows configuration of the referenced payment plan.
- For Direct Debit (ACH), subscribe to NOC and return webhooks to receive updates on account changes and failed transactions.
- Timely handling of notifications prevents payment delays and reduces fees.
- Suitable for membership fees, recurring service charges, or any scheduled billing.
- System manages billing cycles automatically based on plan parameters.

Parameters:
# Name Type Required Default Description
01 object Subscription * Yes Information about the subscription transaction.

find  
Method:  GET       Implicit:  Yes       Returns:  Subscription[] *      
Consumes:  xurl  Produces:  json, xml 
 
Returns a list of available subscriptions.

Parameters:
# Name Type Required Default Description
01 offset Integer No 0 Index of the first record returned from the search result.\n\r\n> **Note:** Used with limit parameter for pagination. Use this field for implementing paginated results.
02 limit Integer No 100 Maximum number of records to load per search call.\n\r\n> **Note:** Adjust based on performance requirements. Use this field to balance response size and performance.
03 billingCycleType String No Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Default: `M` (Monthly). Other options include A (Annual), S (Semi-annual), Q (Quarterly), and W (Weekly).\n\r\n> **Tip:** This typically should match the billing cycle type defined in the referenced plan.
04 createDateFrom Date No Date when the subscription record was created in the system.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is typically populated by the system rather than provided in the request.
05 createDateTo Date No The concluding date for filtering Subscription records; only records up to and through this specified date are included.
06 lastBillingDateFrom Date No The beginning date of the last billing date range for filtering billing records; only records dated from this specified day onwards are included.
07 lastBillingDateTo Date No The concluding date of the last billing date range for filtering billing records; only records up to and through this specified date are included.
08 nextBillingDateFrom Date No The beginning date of the next billing date range for filtering upcoming billing records; only future records dated from this specified day onwards are included.
09 nextBillingDateTo Date No Date when the next billing will occur for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is typically calculated by the system based on the billing cycle.
10 amountFrom Integer No The lower amount limit for filtering Subscription records; only those with values at or above this specified amount are included.
11 amountTo Integer No The upper amount limit for filtering Subscription records; only those with values up to and through this specified amount are included.
12 planId Integer No Reference to the payment plan the customer is subscribing to.\n\r\n> **Note:** This must be a valid payment plan ID already created in the system.\n\r\n> **Tip:** The referenced plan determines the billing amount and available billing cycle options.
13 type String No Type of subscription being created - either fixed-term or perpetual (ongoing). If this value is set to F (Fixed), you must specify the duration using the length field. For ongoing subscriptions, use P (Perpetual).\n\r\n> **Tip:** Choose F (Fixed) for services with a defined end date and P (Perpetual) for ongoing services.
14 status String No Current status of the subscription in the system.\n\r\n> **Note:** This field is typically populated by the system rather than provided in the request.
15 name String(255) No Name of the Subscription used for filtering Subscription records.

Copyright © EON Payments. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.